GtkEventController: Add some comment describing the filter_event private vfunc

It might not be entirely clear what the boolean return value means.

https://bugzilla.gnome.org/show_bug.cgi?id=770026

diff --git a/gtk/gtkeventcontrollerprivate.h b/gtk/gtkeventcontrollerprivate.h
index 2f66ecccbc6d5b9154bc14e690fa4fdd74d310c4..f84719846a22fb19d12606dfac426503d54b2391 100644 (file)
--- a/gtk/gtkeventcontrollerprivate.h
+++ b/gtk/gtkeventcontrollerprivate.h
@@ -37,6 +37,9 @@ struct _GtkEventControllerClass
 
   /*<private>*/
 
+  /* Tells whether the event is filtered out, %TRUE makes
+   * the event unseen by the handle_event vfunc.
+   */
   gboolean (* filter_event) (GtkEventController *controller,
                              const GdkEvent     *event);
   gpointer padding[10];